home *** CD-ROM | disk | FTP | other *** search
/ TEKNO 1996 February / TEKNO 2-1996.iso / quake / network.txt < prev    next >
Text File  |  1996-02-24  |  12KB  |  371 lines
  1. +----------------------------------------+
  2. | The Official Quake Deathmatch TEST     |
  3. | Released Saturday, February 24th, 1996 |
  4. | Copyright (C) 1996 id Software, inc.   |
  5. +----------------------------------------+
  6. | Network Subsystem Documentation        |
  7. | by John Cash                           |
  8. +----------------------------------------+
  9.  
  10. Overview
  11. ========
  12.  
  13. Quake is a client/server game.  You are always
  14. running over some type of network.  In a standalone game, you are
  15. using a loopback network; it just passes messages back and forth
  16. in memory buffers.  This readme is talking about real networks and
  17. multiplayer deathmatches.  There are three main sections: commands,
  18. LANs, and Serial.
  19.  
  20.  
  21. Command Line Parameters, Commands, and Variables
  22. ================================================
  23.  
  24. Command line parameters
  25. -----------------------
  26. "-nolan"
  27. Disables both IPX and TCP/IP support.
  28.  
  29. "-netlog <filename>"
  30. Records all network messages into the specified file.  This is for
  31. debugging use only and will slow your game down *a lot*.
  32.  
  33. "-record"
  34. Server only.  This will create the file quake.vcr and records the game.
  35. This is for debugging server bugs and is NOT a ".lmp"-style demo recording.
  36.  
  37. "-noudp"
  38. Disables support for TCP/IP.
  39.  
  40. "-udpport <port#>"
  41. Specifies a UDP port to be used other than the default of 26000.
  42.  
  43. "-noipx"
  44. Disables support for IPX.
  45.  
  46. "-ipxport <port#>"
  47. Specifies a IPX port to be used other than the default of 26000.
  48.  
  49. "-noserial"
  50. Disable serial support.
  51.  
  52.  
  53. Variables
  54. ---------
  55.  
  56. "net_messagetimeout"
  57. Specifies how long Quake should wait for a message to arrive before
  58. deciding the connection has died.  The default is 3 minutes.  For
  59. reference, messages usually arrive at the rate of about 20 per second.
  60.  
  61. "hostname"
  62. This is the name for your server that will show up on an slist
  63. (see below).  The default value is "unnamed".
  64.  
  65. "net_speeds"
  66. Setting this variable to 1 will cause diagnostic network information
  67. to be displayed once per second.
  68.  
  69.  
  70. Console commands
  71. ----------------
  72.  
  73. "net_stats"
  74. This is for debugging. It displays various network statistics.
  75.  
  76. "slist"
  77. Looks for Quake server on a local LAN (or over a null modem
  78. cable).  This will NOT go outside the local LAN (will not cross
  79. routers).
  80.  
  81.  
  82. LANs
  83. ====
  84.  
  85. Here are the LANs that are supported by the Quake test
  86. release.  For each one, you'll be told how to connect to a server
  87. *if it is not on your local network*.  If it is, you can use the
  88. "slist" command and connect by hostname.  See the main readme for
  89. a discussion of the connect command.
  90.  
  91. Beame & Whiteside TCP/IP
  92. ------------------------
  93.  
  94. This is the only DOS TCP/IP stack supported in the test release.
  95. It is not shareware...it's what we use on our network (in case you
  96. were wondering why this particular stack).  This has been "tested"
  97. *extensively* over ethernet and you should encounter no problems
  98. with it.  Their SLIP and PPP have not been tested.  When connecting
  99. to a server using TCP/IP (UDP actually), you specifiy it's "dot notation"
  100. address (like 123.45.67.89).  You only need to specify the unique portion
  101. of the adress.  For example, if your IP address is 123.45.12.34
  102. and the server's is 123.45.56.78, you could use "connect 56.78".
  103.  
  104. IPX
  105. ---
  106.  
  107. Quake has been run with Novell's ODI IPX stack under DOS,
  108. PDIPX with packet drivers under DOS, and the Microsoft IPX stack
  109. in a Win95 DOS box.  If you use PDIPX, see "known problems" below.
  110. When connecting to a server using IPX, you specify its network:node
  111. address (like 12345678:1234567890AB).  If you are on the same
  112. network, you can just specify the node address.
  113.  
  114. Other
  115. -----
  116.  
  117. We're talking about PPP, SLIP, Kali... anything besides
  118. IPX or B&W as described above.  The answer is: we don't know, we
  119. haven't had time to test it all (doesn't matter what the question
  120. was).
  121.  
  122. Playing over the Internet
  123. -------------------------
  124. Yes, you can play Quake over the Internet.  How many people can be in
  125. the game? That depends.  How smooth will the game be?  That depends.
  126. There are just too many variables (bandwidth, latency, current load,
  127. etc...) for us to make any kind of promises about Internet play.
  128.  
  129.  
  130. Serial/Modem
  131. ============
  132.  
  133. The Quake serial driver supports two COM ports.  Although they are referred
  134. to as COM1 and COM2, you can configure them to use any normal hardware
  135. COM port (1 thru 4 on most PCs).  The com ports are used with interrupts,
  136. so their IRQ may not be used for another purpose (such as a LAN adapter
  137. or sound card).  The IRQ may not be shared with another device either;
  138. not even another COM port.  A client can only be connected to one server
  139. at a time, so multiple ports are really only useful on a server.
  140. When using modems, the client must originate the call and the server
  141. must answer.  This holds true even for a two player, non-dedicated
  142. server configuration.
  143.  
  144. *** Modem support does NOT work at this time ***
  145. Serial play is only supported via direct connection (null modems cables).
  146. It *might* work to establish a modem connection before running Quake
  147. and then treating it like a direct connection... *BUT* this has
  148. not been tried or tested.
  149.  
  150. The COMx commands
  151. -----------------
  152.  
  153. There are two commands to support serial/modem play for Quake.  They
  154. are: COM1 and COM2. Entering one of these commands with no arguments
  155. will display the status of that serial port, similar to this:
  156.  
  157. Settings for COM1
  158. enabled:   true
  159. connected: false
  160. uart:      16550
  161. port:      3f8
  162. irq:       4
  163. baud:      28800
  164. CTS:       honored
  165. DSR:       honored
  166. CD:        honored
  167. startup:
  168. shutdown:
  169.  
  170. When used with arguments, these commands change the settings and
  171. status of the COM ports.  The possible arguments are listed below;
  172. examples follow.
  173.  
  174. enable | disable
  175. "enable" means that your configuration is complete and you want to use
  176. the COM port.  "disable" is used to turn off a COM port, usually to
  177. change its settings.  The default (initial) state is disabled.
  178.  
  179.  
  180. dial | answer
  181. Specifying one of these two options indicates that you are using a modem.
  182. "dial" is used for Quake clients and means that you will be initiating the
  183. call.  "answer" is used for Quake servers and means that you will be
  184. receiving the call(s).  Using neither of these means that you are using
  185. a null modem cable and modem processing will be disabled.
  186.  
  187.  
  188. reset
  189. This will reset the COM port to its default settings and state.
  190.  
  191.  
  192. port <n>
  193. irq <n>
  194. These are used to set the I/O Port and IRQ that your serial port uses.
  195. The default values are: port=3f8 irq=4 for COM1 and port=2f8 irq=3 for
  196. COM2.  Note that the port number is displayed in hexadecimal; to enter
  197. it you would use something like "COM2 port 0x2f8"; the "0x" preceding
  198. the "2f8" indicates that you are giving the value in hexadecimal
  199. otherwise decimal is assumed.
  200.  
  201.  
  202. baud <n>
  203. Sets the baud rate.  Valid values for <n> are: 9600, 14400,
  204. 28800, 57600, and 115200.  28800 is the default.  Please note that
  205. this is the baud rate used for the uart, not your modem.  It is
  206. perfectly valid to use 57600 on a COM port that is connected to a
  207. 28.8 modem.
  208.  
  209. 8250 | 16550
  210. Specifies the type of uart chip in your system. Normally this is
  211. automatically detected, one of these need only be used if your chip
  212. is incorrectly detected.
  213.  
  214. startup
  215. shutdown
  216. This allows you to specify the startup and shutdown strings needed for
  217. a modem for playing Quake.  If you've found values that previously worked
  218. with Doom, use them here.  If you are playing over a null modem cable,
  219. leave these blank.
  220.  
  221. -cts | +cts
  222. -dsr | +dsr
  223. -cd  | +cd
  224. These determine if certain serial control lines should be honored or ignored. The "-" means you want
  225. that line ignored, the "+" means to honor it. "cts" is an abbreviation
  226. for "clear to send", "dsr" for "data set ready", and "cd" for
  227. "carrier detect".  Most people will not need to change these values.
  228. The default is to honor all 3 lines.
  229.  
  230. Quake always uses no parity, 8 data bits, and 1 stop bit; these
  231. values can not be changed.  The baud, port, irq, and uart type can
  232. not be changed on an enabled port, you must disable it first.
  233.  
  234.  
  235. Configuration examples
  236. ----------------------
  237. Example1: You have a machine with two serial ports you are going
  238. to use as a Quake server.  COM1 will be using a null modem cable and
  239. COM2 will be connected to a 14.4 modem.  You would use commands similar
  240. (the startup string would almost certainly be different) to these:
  241.  
  242. COM1 baud 57600 enable
  243. COM2 baud 14400 answer startup AT\N0%C0B8 enable
  244.  
  245.  
  246. Example2: You are going to use your machine to connect to a dial-up
  247. Quake server with your 28.8 modem connected to COM2.  You would
  248. use a command something like this:
  249.  
  250. COM2 baud 57600 dial startup AT\N0%C0B8 enable
  251.  
  252. Note the baud rate is not the same as the modem speed.  This allows
  253. the modem-to-uart communications to occur at a higher rate than
  254. the modem-to-modem communications.
  255.  
  256. Connecting to a serial Quake server
  257. -----------------------------------
  258.  
  259. Connecting to a Quake server over a serial/modem connection is done
  260. using the "connect" command.  A "#" is used to indicate that you
  261. are going to connect using a modem.  For example, the command
  262. "connect #5551212" would try to connect to a Quake server at the
  263. phone number 555-1212.  Note: your local phone company would probably
  264. appreciate it if you didn't try this number!
  265.  
  266. If you are using a null modem cable, you can simply type "connect".
  267. Quake will then attempt to connect to the server.
  268.  
  269. There is no provision for a dialing directory yet.
  270.  
  271.  
  272. Known problems / workarounds
  273. ============================
  274. Packet drivers with PDIPX - there is a bug that stops a server running on
  275. this combination from responding to the slist command.  There are
  276. two workarounds.  One, use Novell's IPX stack.  Two, connect by
  277. address (see IPX notes).
  278.  
  279. Win95 - For Quake to run under Win95, you must have an IPX Networking
  280. Protocol installed.  To do this, open up "My Computer->Control
  281. Panel->Network".  Click on "Add->Protocol -> Add->Microsoft ->
  282. IPX/SPX-compatible Protocol -> OK". If you are not using IPX for network
  283. client services (to a NetWare server), do not bind it to the requester.
  284. Also, you need to pay careful attention to the setting of the "frame type"
  285. under "advanced properties" to make sure it is correct for your network.
  286.  
  287.  
  288. Bug Reporting
  289. =============
  290. If you encounter a network-related bug, please fill out the following
  291. form and e-mail it to qtest1@idsoftware.com. There are several problems
  292. that are not bugs, and shouldn't be reported, including:
  293.  
  294. * modem play does not currently work
  295.  
  296. * sluggish performance, especially on 486s, heavily loaded LANs,
  297. and the Internet
  298.  
  299. * IPX servers running on PDIPX will not repsond to the slist command
  300.  
  301. * Improper frame type selection under Win95
  302.  
  303. Apart from these, we would very much like to hear about any network
  304. problems you encounter.
  305.  
  306.  
  307. -------------------------------cut here-------------------------------------
  308.  
  309.                Quake Demo #1 Bug Report
  310.  
  311.  
  312. E-mail to: qtest1@idsoftware.com
  313.  
  314.  
  315. Date:
  316.  
  317.  
  318. Name:
  319.  
  320. Company:
  321.  
  322. Street address:
  323.  
  324. City, state, ZIP:
  325.  
  326. Phone:
  327.  
  328. Fax:
  329.  
  330. E-mail:
  331.  
  332.  
  333. Please provide the following information about the server and
  334. clients; be sure to indicate which machine is the server.
  335.  
  336.  
  337. Manufacturer/model of LAN adapters:
  338.  
  339.  
  340.  
  341. Network configuration (eg., NET.CFG file):
  342.  
  343.  
  344.  
  345. Drivers, protocol stacks, and versions:  (eg., lsl v2.14, exp16odi
  346. v2.33, and ipxodi v3.01)
  347.  
  348.  
  349.  
  350. What operating system are you running?  (eg., DOS 6.0 or Windows
  351. 95):
  352.  
  353.  
  354.  
  355. If there were any error messages or fault information, report them
  356. here:
  357.  
  358.  
  359.  
  360. Execute the net_stats command and give the results for each machine:
  361.  
  362.  
  363.  
  364. Please describe the problem you are encountering, including a
  365. procedure for reproducing the problem:
  366.  
  367.  
  368.  
  369.  
  370. -------------------------------cut here-------------------------------------
  371.